<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aws-crt-cpp: Aws::Iot::WebsocketConfig Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">aws-crt-cpp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceAws.html">Aws</a></li><li class="navelem"><a class="el" href="namespaceAws_1_1Iot.html">Iot</a></li><li class="navelem"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html">WebsocketConfig</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structAws_1_1Iot_1_1WebsocketConfig-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Aws::Iot::WebsocketConfig Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="iot_2MqttClient_8h_source.html">MqttClient.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3cbae6e4be97378adf57e09b4b3ae855"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#a3cbae6e4be97378adf57e09b4b3ae855">WebsocketConfig</a> (const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;signingRegion, <a class="el" href="classAws_1_1Crt_1_1Io_1_1ClientBootstrap.html">Crt::Io::ClientBootstrap</a> *bootstrap, <a class="el" href="namespaceAws_1_1Crt.html#a3c9efb213e2de565038afcfd4f8afcda">Crt::Allocator</a> *allocator=<a class="el" href="namespaceAws_1_1Crt.html#a7178ef65f261a8db52a624458331bbb2">Crt::g_allocator</a>) noexcept</td></tr>
<tr class="separator:a3cbae6e4be97378adf57e09b4b3ae855"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90426b45f013721182aeb248b7115d8c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#a90426b45f013721182aeb248b7115d8c">WebsocketConfig</a> (const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;signingRegion, const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a> &gt; &amp;credentialsProvider, <a class="el" href="namespaceAws_1_1Crt.html#a3c9efb213e2de565038afcfd4f8afcda">Crt::Allocator</a> *allocator=<a class="el" href="namespaceAws_1_1Crt.html#a7178ef65f261a8db52a624458331bbb2">Crt::g_allocator</a>) noexcept</td></tr>
<tr class="separator:a90426b45f013721182aeb248b7115d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad38f60d631a05662c1adfa3cbc0e8f51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#ad38f60d631a05662c1adfa3cbc0e8f51">WebsocketConfig</a> (const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a> &gt; &amp;credentialsProvider, const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1IHttpRequestSigner.html">Crt::Auth::IHttpRequestSigner</a> &gt; &amp;signer, <a class="el" href="namespaceAws_1_1Iot.html#a4b7bd202524f790cef32d4cd5830d787">CreateSigningConfig</a> createSigningConfig) noexcept</td></tr>
<tr class="separator:ad38f60d631a05662c1adfa3cbc0e8f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aff5042d2b565f8270b3746dfe0d9f5a6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#aff5042d2b565f8270b3746dfe0d9f5a6">CredentialsProvider</a></td></tr>
<tr class="separator:aff5042d2b565f8270b3746dfe0d9f5a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11e130fd6dac6864a4d41a756e4db27a"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1IHttpRequestSigner.html">Crt::Auth::IHttpRequestSigner</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#a11e130fd6dac6864a4d41a756e4db27a">Signer</a></td></tr>
<tr class="separator:a11e130fd6dac6864a4d41a756e4db27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af939f64ba2c130fe0e6535e6d90aedb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAws_1_1Iot.html#a4b7bd202524f790cef32d4cd5830d787">CreateSigningConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#af939f64ba2c130fe0e6535e6d90aedb2">CreateSigningConfigCb</a></td></tr>
<tr class="separator:af939f64ba2c130fe0e6535e6d90aedb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac80d61d69aa5ad62b7cc5e953767bf30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAws_1_1Crt_1_1Optional.html">Crt::Optional</a>&lt; <a class="el" href="classAws_1_1Crt_1_1Http_1_1HttpClientConnectionProxyOptions.html">Crt::Http::HttpClientConnectionProxyOptions</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#ac80d61d69aa5ad62b7cc5e953767bf30">ProxyOptions</a></td></tr>
<tr class="separator:ac80d61d69aa5ad62b7cc5e953767bf30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37fbae74b51ef56bc47513fdea4325f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#a37fbae74b51ef56bc47513fdea4325f0">SigningRegion</a></td></tr>
<tr class="separator:a37fbae74b51ef56bc47513fdea4325f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a3f538f5ae05a41e4ad4f3f287c6d9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAws_1_1Iot_1_1WebsocketConfig.html#a2a3f538f5ae05a41e4ad4f3f287c6d9e">ServiceName</a></td></tr>
<tr class="separator:a2a3f538f5ae05a41e4ad4f3f287c6d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3cbae6e4be97378adf57e09b4b3ae855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cbae6e4be97378adf57e09b4b3ae855">&#9670;&nbsp;</a></span>WebsocketConfig() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::WebsocketConfig::WebsocketConfig </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;&#160;</td>
          <td class="paramname"><em>signingRegion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classAws_1_1Crt_1_1Io_1_1ClientBootstrap.html">Crt::Io::ClientBootstrap</a> *&#160;</td>
          <td class="paramname"><em>bootstrap</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceAws_1_1Crt.html#a3c9efb213e2de565038afcfd4f8afcda">Crt::Allocator</a> *&#160;</td>
          <td class="paramname"><em>allocator</em> = <code><a class="el" href="namespaceAws_1_1Crt.html#a7178ef65f261a8db52a624458331bbb2">Crt::g_allocator</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create a websocket configuration for use with the default credentials provider chain. Signing region will be used for Sigv4 signature calculations. </p>

</div>
</div>
<a id="a90426b45f013721182aeb248b7115d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90426b45f013721182aeb248b7115d8c">&#9670;&nbsp;</a></span>WebsocketConfig() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::WebsocketConfig::WebsocketConfig </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;&#160;</td>
          <td class="paramname"><em>signingRegion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>credentialsProvider</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceAws_1_1Crt.html#a3c9efb213e2de565038afcfd4f8afcda">Crt::Allocator</a> *&#160;</td>
          <td class="paramname"><em>allocator</em> = <code><a class="el" href="namespaceAws_1_1Crt.html#a7178ef65f261a8db52a624458331bbb2">Crt::g_allocator</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create a websocket configuration for use with a custom credentials provider. Signing region will be use for Sigv4 signature calculations. </p>

</div>
</div>
<a id="ad38f60d631a05662c1adfa3cbc0e8f51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad38f60d631a05662c1adfa3cbc0e8f51">&#9670;&nbsp;</a></span>WebsocketConfig() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::WebsocketConfig::WebsocketConfig </td>
          <td>(</td>
          <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>credentialsProvider</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classAws_1_1Crt_1_1Auth_1_1IHttpRequestSigner.html">Crt::Auth::IHttpRequestSigner</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>signer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceAws_1_1Iot.html#a4b7bd202524f790cef32d4cd5830d787">Iot::CreateSigningConfig</a>&#160;</td>
          <td class="paramname"><em>createConfig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create a websocket configuration for use with a custom credentials provider, and a custom signer.</p>
<p>You'll need to provide a function for use with creating a signing Config and pass it to createSigningConfig.</p>
<p>This is useful for cases use with: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/custom-auth.html">https://docs.aws.amazon.com/iot/latest/developerguide/custom-auth.html</a> </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af939f64ba2c130fe0e6535e6d90aedb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af939f64ba2c130fe0e6535e6d90aedb2">&#9670;&nbsp;</a></span>CreateSigningConfigCb</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceAws_1_1Iot.html#a4b7bd202524f790cef32d4cd5830d787">CreateSigningConfig</a> Aws::Iot::WebsocketConfig::CreateSigningConfigCb</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aff5042d2b565f8270b3746dfe0d9f5a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff5042d2b565f8270b3746dfe0d9f5a6">&#9670;&nbsp;</a></span>CredentialsProvider</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">Crt::Auth::ICredentialsProvider</a>&gt; Aws::Iot::WebsocketConfig::CredentialsProvider</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ac80d61d69aa5ad62b7cc5e953767bf30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac80d61d69aa5ad62b7cc5e953767bf30">&#9670;&nbsp;</a></span>ProxyOptions</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classAws_1_1Crt_1_1Optional.html">Crt::Optional</a>&lt;<a class="el" href="classAws_1_1Crt_1_1Http_1_1HttpClientConnectionProxyOptions.html">Crt::Http::HttpClientConnectionProxyOptions</a>&gt; Aws::Iot::WebsocketConfig::ProxyOptions</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Specify ProxyOptions to use a proxy with your websocket connection. </p>

</div>
</div>
<a id="a2a3f538f5ae05a41e4ad4f3f287c6d9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a3f538f5ae05a41e4ad4f3f287c6d9e">&#9670;&nbsp;</a></span>ServiceName</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> Aws::Iot::WebsocketConfig::ServiceName</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a11e130fd6dac6864a4d41a756e4db27a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11e130fd6dac6864a4d41a756e4db27a">&#9670;&nbsp;</a></span>Signer</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classAws_1_1Crt_1_1Auth_1_1IHttpRequestSigner.html">Crt::Auth::IHttpRequestSigner</a>&gt; Aws::Iot::WebsocketConfig::Signer</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a37fbae74b51ef56bc47513fdea4325f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37fbae74b51ef56bc47513fdea4325f0">&#9670;&nbsp;</a></span>SigningRegion</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> Aws::Iot::WebsocketConfig::SigningRegion</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/include/aws/iot/<a class="el" href="iot_2MqttClient_8h_source.html">MqttClient.h</a></li>
<li>/home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/source/iot/<a class="el" href="iot_2MqttClient_8cpp.html">MqttClient.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
